home *** CD-ROM | disk | FTP | other *** search
/ Directorty Opus 5 - Magellan 2 / Opus 5 - Magellan 2.iso / DOpus_SDK_5.5 / docs / clipboard.doc < prev    next >
Text File  |  1996-09-05  |  3KB  |  108 lines
  1. TABLE OF CONTENTS
  2.  
  3. dopus5.library/CloseClipBoard
  4. dopus5.library/OpenClipBoard
  5. dopus5.library/ReadClipString
  6. dopus5.library/WriteClipString
  7. dopus5.library/CloseClipBoard                   dopus5.library/CloseClipBoard
  8.  
  9.     NAME
  10.         CloseClipBoard - close a clipboard handle
  11.  
  12.     SYNOPSIS
  13.         CloseClipBoard(handle)
  14.                          A0
  15.  
  16.         void CloseClipBoard(APTR);
  17.  
  18.     FUNCTION
  19.         Closes a handle to the clipboard opened with OpenClipBoard().
  20.  
  21.     INPUTS
  22.         handle - clipboard handle
  23.  
  24.     RESULT
  25.         The clipboard unit is closed.
  26.  
  27.     SEE ALSO
  28.         OpenClipBoard()
  29.  
  30. dopus5.library/OpenClipBoard                     dopus5.library/OpenClipBoard
  31.  
  32.     NAME
  33.         OpenClipBoard - open clipboard for easy access
  34.  
  35.     SYNOPSIS
  36.         OpenClipBoard(unit)
  37.                        D0
  38.  
  39.         APTR OpenClipBoard(ULONG);
  40.  
  41.     FUNCTION
  42.         This function opens a specified unit of the clipboard.device. Used
  43.         with the other clipboard functions, it provides an easy method to
  44.         manipulate text strings with the clipboard.
  45.  
  46.     INPUTS
  47.         unit - unit number to open (usually 0)
  48.  
  49.     RESULT
  50.         Returns clipboard handle.
  51.  
  52.     SEE ALSO
  53.         CloseClipBoard()
  54.  
  55. dopus5.library/ReadClipString                   dopus5.library/ReadClipString
  56.  
  57.     NAME
  58.         ReadClipString - read a text string from the clipboard
  59.  
  60.     SYNOPSIS
  61.         ReadClipString(handle, buffer, size)
  62.                          A0      A1     D0
  63.  
  64.         long ReadClipString(APTR, char *, long);
  65.  
  66.     FUNCTION
  67.         This function reads a string of text from the clipboard handle.
  68.  
  69.     INPUTS
  70.         handle - clipboard handle
  71.         buffer - buffer to store string
  72.         size - size of buffer
  73.  
  74.     RESULT
  75.         Returns the length of the string. If there was no valid FTXT string
  76.         in the clipboard, it returns 0.
  77.  
  78.     SEE ALSO
  79.         OpenClipBoard(), WriteClipString()
  80.  
  81. dopus5.library/WriteClipString                 dopus5.library/WriteClipString
  82.  
  83.     NAME
  84.         WriteClipString - write a text string to the clipboard
  85.  
  86.     SYNOPSIS
  87.         WriteClipString(handle, buffer, size)
  88.                           A0      A1     D0
  89.  
  90.         BOOL WriteClipString(APTR, char *, long);
  91.  
  92.     FUNCTION
  93.         This function writes a string of text to the clipboard handle.
  94.  
  95.     INPUTS
  96.         handle - clipboard handle
  97.         buffer - buffer containing string
  98.         size - length of string
  99.  
  100.     RESULT
  101.         Returns TRUE if it succeeded, FALSE otherwise. The string is stored
  102.         in standard FTXT format, readable by ReadClipString() and most
  103.         other programs that access the clipboard.
  104.  
  105.     SEE ALSO
  106.         OpenClipBoard(), ReadClipString()
  107.  
  108.